---
title: 水印
icon: Waves
---

<MetaData
  lang="zh-CN"
  meta={{
    plugins: [{
      client: '@univerjs/watermark',
      facade: '@univerjs/watermark/facade',
    }],
    server: '否',
  }}
/>

水印功能只在为电子表格提供水印功能。它允许开发者在电子表格中添加文本或图片水印，并提供多种配置选项来定制水印的外观和行为。

<PlaygroundFrame lang="zh-CN" slug="sheets/watermark" clickToShow />

## 预设模式

水印并未提供预设模式，但支持与其插件混用。

### 安装

```package-install
npm install @univerjs/watermark
```

### 使用

```typescript
import { UniverWatermarkPlugin } from '@univerjs/watermark' // [!code ++]

import '@univerjs/watermark/facade' // [!code ++]

const { univerAPI } = createUniver({
  // ...
  presets: [
    UniverSheetsCorePreset(),
  ],
  plugins: [
    [UniverWatermarkPlugin, { // [!code ++]
      textWatermarkSettings: { // [!code ++]
        content: 'Hello, Univer!', // [!code ++]
        fontSize: 36, // [!code ++]
      }, // [!code ++]
    }], // [!code ++]
  ],
})
```

## 插件模式

### 安装

```package-install
npm install @univerjs/watermark
```

### 使用

```typescript
import { UniverWatermarkPlugin } from '@univerjs/watermark' // [!code ++]

import '@univerjs/watermark/facade' // [!code ++]

const univer = new Univer({
  // ...
})

univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++]
  textWatermarkSettings: { // [!code ++]
    content: 'Hello, Univer!', // [!code ++]
    fontSize: 36, // [!code ++]
  }, // [!code ++]
}) // [!code ++]
```

### 插件与配置

#### @univerjs/watermark

本插件提供了水印功能的核心实现。它允许开发者在应用中添加文本或图片水印，并提供多种配置选项来定制水印的外观和行为。其提供了 `UniverWatermarkPlugin` 插件。

参考：[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark)

## Facade API

### 设置水印

```typescript
univerAPI.addWatermark('text', { content: 'hello', repeat: true })
```

### 移除水印

```typescript
univerAPI.deleteWatermark()
```
